Improve docs for gdk_pixbuf_new_from_file_at_scale(). Proposed by Juan

        * gdk-pixbuf-io.c: Improve docs for gdk_pixbuf_new_from_file_at_scale().
        Proposed by Juan Manuel Palacios

svn path=/trunk/; revision=20828

diff --git a/gdk-pixbuf/ChangeLog b/gdk-pixbuf/ChangeLog
index 6338ee425673ada692e3e69eb115ed64fe9969f3..2d6a730ddcf21786c1def30e77306e50e71095f2 100644 (file)
--- a/gdk-pixbuf/ChangeLog
+++ b/gdk-pixbuf/ChangeLog
@@ -1,3 +1,11 @@
+2008-07-14  Matthias Clasen  <mclasen@redhat.com>
+
+       Bug 401985 – Documentation improvement for the
+       gdk_pixbuf_new_from_file_at_scale() function
+
+       * gdk-pixbuf-io.c: Improve docs for gdk_pixbuf_new_from_file_at_scale().
+       Proposed by Juan Manuel Palacios
+
 2008-07-11  Matthias Clasen  <mclasen@redhat.com>
 
        * gdk-pixbuf-io.c: Use GIO for sniffing image types, except

diff --git a/gdk-pixbuf/gdk-pixbuf-io.c b/gdk-pixbuf/gdk-pixbuf-io.c
index 27cb18ee0a5f3e124779d96a06230ffa7b44e95e..ea6f5293c18750b32975dbeeb834c87b26f156c9 100644 (file)
--- a/gdk-pixbuf/gdk-pixbuf-io.c
+++ b/gdk-pixbuf/gdk-pixbuf-io.c
@@ -1040,11 +1040,16 @@ gdk_pixbuf_new_from_file (const char *filename,
  * @height: The height the image should have or -1 to not constrain the height
  * @error: Return location for an error
  *
- * Creates a new pixbuf by loading an image from a file.  The file format is
- * detected automatically. If %NULL is returned, then @error will be set.
- * Possible errors are in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains.
+ * Creates a new pixbuf by loading an image from a file.  
+ * The file format is detected automatically. If %NULL is returned, then 
+ * @error will be set. Possible errors are in the #GDK_PIXBUF_ERROR and 
+ * #G_FILE_ERROR domains.
+ *
  * The image will be scaled to fit in the requested size, preserving
- * the image's aspect ratio.
+ * the image's aspect ratio. Note that the returned pixbuf may be smaller
+ * than @width x @height, if the aspect ratio requires it. To load
+ * and image at the requested size, regardless of aspect ratio, use
+ * gdk_pixbuf_new_from_file_at_scale().
  *
  * Return value: A newly-created pixbuf with a reference count of 1, or 
  * %NULL if any of several error conditions occurred:  the file could not